provider Basic GET
/crm/v3/objects/contacts/{contactId} @utdk/hubspot
/crm/v3/objects/contacts/{contactId} Retrieve a contact
Retrieve a contact by its ID (`contactId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.
- contactId path required
- string
- archived query
- Whether to return only results that have been archived.
- boolean
- associations query
- A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
- array
- idProperty query
- The name of a property whose values are unique for this object type
- string
- properties query
- A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
- array
- propertiesWithHistory query
- A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
- array
Try it
Authentication
Configure credentials for Contacts
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import hubspot from '@utdk/hubspot';
await hubspot.get.crm.v3.objects.contacts.contactidGetbyid({
"archived": false
})